The CxFmsBalanceCtrl object contains the following properties.
Note: Time format selection is not available in this control. The Balance control displays data in Contract time (C), with one exception. The Last Modified column displays the timestamp of the last modification in Local time (L).
| Property | SubType | Read Only | Description |
|---|---|---|---|
|
Integer |
No |
Returns/sets the appearance of the object boundary. Possible values for this property are as follows.
Default value is 0 - Flat |
|
|
String |
No |
Returns/sets the starting date of the FMS Balance control. This string can be in one of the following forms.
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Default value is T-7 |
|
|
Integer |
No |
Returns/sets the border style. Possible values for this property are as follows.
Default value is 0 - None |
|
|
String |
No |
Returns/sets the filter to be used when retrieving Nodes. Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place. Example A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test". Default value is * (multiple character wildcard) |
|
|
Integer |
No |
Returns/sets the Node property that will be filtered by the string specified in the ChooserFilterString property. Possible values for this property are as follows.
Default value is 0 - Name |
|
|
String |
No |
Returns/sets the group currently selected in the Node chooser’s Group combo box. Default value is All Nodes |
|
|
Integer |
No |
Returns/sets the primary sort column of the Node chooser’s Node list. Possible values for this property are as follows.
Default value is 2 - Name ascending |
|
|
String |
No |
Returns/sets the Site.Service currently selected in the Node chooser’s FMS service combo box. |
|
|
Boolean |
No |
Returns/sets whether or not the Node chooser’s FMS service combo box is visible. Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
String |
No |
Returns/sets the XML specifying the custom FMS commands configured for the control. Another way to configure this property is to use the control’s property page. |
|
|
String |
No |
Returns/sets the XML specifying the columns that will be displayed in the FMS Balance control. Another way to configure this property is to use the control's property page. |
|
|
String |
No |
Returns/sets the XML specifying the accumulated color settings for the FMS Balance control. Another way to configure this property is to use the control's property page. |
|
|
Integer |
No |
Returns/sets whether dates displayed in the FMS Balance control will have the time appear before the date (leading) or after the date (trailing). Possible values for this property are as follows.
Default value is 0 - LeadingTime |
|
|
String |
No |
Returns/sets the ending date of the FMS Balance control. This string can either be in the form of an Absolute date, for example, 1/31/2019, or a Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today). Note: This property is only used if the UseSessionOptions property is set to 0 - No. Default value is T |
|
|
StdFont |
No |
Returns/sets the font used by the FMS Balance control. Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
String |
No |
Returns/sets the Point in Time date and time of the FMS Balance control. This string can be in one of the following forms.
Default value is T, date and time today. See Using the Home Menu for more information about PIT mode. Note: This property is only used if the UsePIT property is set to 1 - Yes. |
|
|
String |
No |
Returns/sets the Session starting date for the time window displayed in the control. This string can be in one of the following forms.
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Returns/sets the Session ending date for the time window displayed in the control. This string can be in one of the following forms.
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Returns/sets the Session Node tag, which specifies the active Node in the FMS Balance control. This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540). Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
Boolean |
No |
Returns/sets whether or not the Chooser pane will be displayed in the control. Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Boolean |
No |
Returns/sets whether or not the Options pane will be displayed in the control. Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
String |
No |
Returns/sets the unit set used to determine the units of each FMS data item in the FMS Balance control. Another way to configure this property is to use either the control’s property page or to use the Options page on the FMS Balance control. Default value is the <Default> unit set |
|
|
Boolean |
No |
Returns/sets whether or not the PITDateTime property will be used. Possible values for this property are as follows.
Default value is 0 - No |
|
|
Boolean |
No |
Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS Balance control. If this property is set to 0 - No, the FMS Balance control will present a Chooser page for selection of the active Node. Possible values for this property are as follows.
Default value is 0 - No |
|
|
Boolean |
No |
Returns/sets whether or not the SessionBeginDate and SessionEndDate properties will be used in place of the BeginDate and EndDate properties. Possible values for this property are as follows.
Default value is 0 - No |